home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / comm / prtcs155.zip / GENMAILE.DOC < prev    next >
Text File  |  1994-01-14  |  58KB  |  1,444 lines
  1. $VER: GENMAILER DOC Shelter Mailer Configuration Documentation Williamson 1.50
  2.  
  3.     GenMailer  reads  an  number  of config files and generates a number of
  4. site  specific  wpl  programs  for  one  of the Shelter Mailers:  The Roof,
  5. Porticus,  Gazebo  and  Umbrella Mailers.  Certain rexx ClipVars,as well as
  6. ENVARC:   and  ENV:   variables  are  set for use by the particular Shelter
  7. Mailer's Manager program and by other external rexx scripts.
  8.  
  9.     Thanks  to  Yanik  Grignon and Matthew Mondor for their invaluable Beta
  10. testing help. 
  11.  
  12.     Thanks  to  Russell  McOrmond for wpl.library and xprfts.library, James
  13. McOrmond for wplemsi.library and Yves Konigshofer for xprzedzap.library.
  14.  
  15.  Usage: GenMailer MailerName mode [path]
  16.         GenMailer (ROOF|PORTICUS|GAZEBO|UMBRELLA)
  17.  
  18.            ALL          All output modules are generated
  19.            EMSI         EMSI is added to ALL
  20.            ALLNC        Cache, Clock [and Notify] modules are not regenerated
  21.            EMSINC       Cache, Clock [and Notify] modules are not regenerated  
  22.            CACHE        Regenerate and Reload Site Cache
  23.  
  24.     Internal options:
  25.     Within  the first few lines of GenMailer.rexx you will find a number of
  26. switches.
  27.  
  28.     CKDOMAIN=1
  29.         If 1, will fix the domain of the primary address presented, 
  30.         If that domain is FIDONET and Zone is NOT 1-6. If we find a
  31.         match  for the zone the remote site presented in our AKA list,
  32.         we will use the related domain.
  33.  
  34.     KILLBAD=0
  35.         If 1, we will hang up if remote presents a bad password for
  36.         primary address
  37.         If 0, we will send only files that have been queued for a site
  38.         named BADPASSWORD. (See EMSI_LINKS.DOC)
  39.         
  40.     KNOWNAKAONLY=1  
  41.         If 1, we will onlt send file for those AKAs we have listed in the
  42.         SiteCache.
  43.         If 0, we will only send file for the PRIMARY address presented.
  44.  
  45.     SHOWXPRASC=0
  46.         If 1, Xprascii transfer window will be displayed if showxpr is
  47.         TRUE.
  48.         If 0, XPRascii transfer window will not be displayed.
  49.  
  50.     REXXDOS=1
  51.         If 1, RexxDosSupport.library had been LoadLib'ed and RxLib'ed
  52.         in Startup-Sequence or Start-ARexx user startup.
  53.  
  54.  
  55.  
  56. ENVIRONMENT:
  57.  
  58.     All Shelter Mailers expect certain devices and libraries:
  59.  
  60.         - NULL: device mounted.
  61.         - rexxsupport.library addlib'ed
  62.         - ENVARC: copied to ENV: in startup-sequence
  63.  
  64.     Required Assigns:
  65.         CFG:          - all configuration information is here
  66.         LOG:          - logs and accounts
  67.         Mail:         - executables
  68.         Info:         - banner, bulletin, help and text files
  69.         XFERQ:        - outbound queues (created from mailerGEN.cfg)
  70.                         this must be a unused directory
  71.  
  72.     Required Libraries:
  73.         rexxsupport.library
  74.         rexxdossupport.library
  75.         hgrexxsupport.library
  76.         wpl.library
  77.         wplemsi.library
  78.         xferq.library
  79.         xprzedzap.library
  80.         xprfts.library
  81.         xprascii.library
  82.         OwnDevUnit.library
  83.         msgbase.library     (if using TLlookup)
  84.  
  85.     Required Devices:
  86.         null.device
  87.  
  88.     Required Directories:
  89.         GenMailer  and Shelter will create most of the directories required
  90. by each Shelter Mailer.
  91.  
  92.     For  Porticus  and  Roof,  when  using  RFS  and  WPLRX  utilities, the
  93. following additional directories must be created.
  94.  
  95.     INFO:           contains text and help files, banner and bulletin
  96.                     I use CFG:INFO
  97.  
  98.     LOG:rfsacct/    contains mailer accounts.
  99.  
  100.     LOG:rfsacct/h/  contains Grab user accounts as well as
  101.                     sysop messages to users.
  102.  
  103.     LOG:freqit/     Wfreqit accounts
  104.     CFG:freqit/     Wfreqit configuration, help and text files
  105.  
  106.  
  107.     See Shelter.doc for additional requirements.
  108.  
  109.     Input Files:
  110.         CFG:screen.cfg
  111.         CFG:wpl/gen/roof/RoofGen.cfg
  112.         CFG:wpl/gen/porticus/PorticusGen.cfg
  113.         CFG:wpl/gen/gazebo/GazeboGen.cfg
  114.         CFG:wpl/gen/umbella/UmbrellaGen.cfg
  115.  
  116.         These  contain  config  information  related  to  the site:  aka's,
  117. sysopname,  sitename; directories used ; program specific values ; and user
  118. related menus and prompts.
  119.  
  120.         CFG:wpl/gen/mailername/src/
  121.         Contains features under development for each mailer.
  122.         Do NOT modify these.
  123.  
  124.         Generated OutPut files:
  125.         roofCFG.wpl and roofMENUS.wpl
  126.         porticusCFG.wpl and porticusMENUS.wpl
  127.         gazeboCFG.wpl
  128.         umbrellaCFG.wpl
  129.  
  130.  
  131. MAILER CONFIGURATION
  132. --------------------
  133.  Screen.CFG:
  134.     If the SCREEN name is not 'WORKBENCH SCREEN', and the configured SCREEN
  135. is  not  already opened, a public screen will be opened using ScreenManager
  136. (1.13c) and the information in Screen.cfg.
  137.     PLEASE SEE ScreenManger 1.13c docs (FREQ:  ScreenMgr1_13c.LZH) for more
  138. information on the options.
  139.  
  140.     Keywords descriptions extracted from ScreenManager.DOC.
  141.  
  142.     TEXTOVERSCAN_WIDTH=652
  143.     TEXTOVERSCAN_HEIGHT=230
  144.             These  are  the  TEXT  OVERSCAN  VALUES as defined in the Prefs
  145.             program OVERSCAN.
  146.  
  147.     SCREENMODES="H"
  148.             Determines  the  graphics  mode (and thus the resolution).
  149.             You  just  provide  a  letter representing the ScreenMode name,
  150.             like  those  found  in  the  ScreenMode  preferences  tool.  It
  151.             depends  on  your  graphics  hardware (ECS,AGA,AAA) and monitor
  152.             (Multiscan,...)  which  modes  are  available  and  how you may
  153.             combine these.  If a certain mode is not available, you will be
  154.             told so in an error message.
  155.  
  156.             These are the letters you can use:
  157.                 H: HiRes        (Default value: LoRes)
  158.                 L: Lace         (Default value: no interlace)
  159.                 S: SuperHiRes
  160.                 E: ExtraHalfBright
  161.                 V: VGA
  162.                 P: Productivity
  163.                 A: A2024 at 10 Hz
  164.                 F: A2024 at 15 Hz
  165.                 X: HAM
  166.  
  167.             The  desired  mode  is  simply  selected  by  concatenating the
  168.             letters defining it - like in  MODE=SL  for SuperHiRes-Lace.
  169.  
  170.     SCREENGLOBALS
  171.             A comment separated string.
  172.                 SHANGHAI     turns on Shanghai mode
  173.                 NOSHANGHAI   turns off Shanghai mode
  174.                 POPPUB       turns on Poppub mode
  175.                 NOPOPPUB     turns off Poppub mode
  176.                 TOFRONT      open screen in front
  177.                 TOBACK       open screen in back
  178.                 CLOSEGAD     provides a screen with a CLOSE gadget
  179.                 AUTOCLOSE    closes a screen when its last window is closed
  180.                 DEFAULT      makes a screen the system's default screen
  181.             eg: "TOFRONT,AUTOCLOSE"
  182.  
  183.     SCREENCX="CX_TOFRONT='Lshift F1',CX_DEFAULT='F2',CX_PRIORITY='5'"
  184.                 CX_TOFRONT    sets the HotKey to brings screen to front
  185.                 CX_DEFAULT    sets the HotKey to make screen default
  186.                 CX_PRIORITY   sets the HotKeys priority
  187.  
  188.     SCREENPREFS="640,235,3"
  189.         screenprefs - width,height,bitplanes 
  190.  
  191.         planes:
  192.             With  this  value you set the maximum number of colors that can
  193.             be simultaneously displayed, in this way:  # of colors = 2^# of
  194.             planes.   For  different  graphic  modes,  there  are different
  195.             limitations  on  the  value  of  PLANES.   If  these limits are
  196.             exceeded,  you will get a corresponding error message. 
  197.  
  198.  
  199.     SCREENFONT="IBM,8"
  200.             Sets  the  font  and size that will become the screen's default
  201.             font.   This  may  be  a  non-proportional  font  as  well as a
  202.             proportional  font.  If the font cannot be found, the screen is
  203.             still  opened  with the system's default font (this is set with
  204.             the  'Font'  preferences  tool).   Almost any value for size is
  205.             possible    here,   since   the   new   diskfont.library   will
  206.             automatically  scale  the font if the desired size could not be
  207.             found.
  208.     
  209.     RGB Palette Setting:
  210.             This sets the color palette as RGB values.  They are entered as
  211.             3-digit values, separated by spaces.
  212.  
  213.     RGB.0=" 8  4  4"
  214.     RGB.1=" 0  0  4"
  215.                 For 2 or more bitplanes 
  216.     RGB.2="11 12  9"
  217.     RGB.3=" 7  7  6"
  218.                 For 3 or more bitplanes
  219.     RGB.4=" 9  0  2"        
  220.     RGB.5="12  7  1"        
  221.     RGB.6="12  9  3"        
  222.     RGB.7=" 7  6  7"        
  223.                 ADD MORE IF 4 or more  BITPLANES
  224.     RGB.8=" 6  2  0"        
  225.     RGB.9="12 12 12"        
  226.     RGB.10=" 9 15  1"        
  227.     RGB.11="14 10  0"        
  228.     RGB.12=" 5  5 15"        
  229.     RGB.13="12 14 12"        
  230.     RGB.14="13 10  7"        
  231.     RGB.15="14  5  1"        
  232.  
  233.     SCREENPENS="712341206"
  234.         Every  character  is  interpreted  as  a hexadecimal index into the
  235. color  table  that was set with the COLORS command.  From this results that
  236. only the first 16 color registers are usable.
  237.  
  238.       Pen  Name             is used for...  
  239.        1   DETAILPEN        ordinary text (compatible with 1.3) 
  240.        2   BLOCKPEN         ordinary fill operations (compatible with 1.3)  
  241.        3   TEXTPEN          ordinary labels/    
  242.        4   SHINEPEN         shiny edges on 3D objects   
  243.        5   SHADOWPEN        dark edges on 3D objects    
  244.        6   FILLPEN          background of highlighted elements \ e.g. active    
  245.        7   FILLTEXTPEN      text in highlighted elements       / window border  
  246.        8   BACKGROUNDPEN    background - must be set to 0   
  247.        9   HIGHLIGHTTEXTPEN emphasized text 
  248.  
  249.   Make  SURE you do not reference color registers that are not available for
  250. the number of Planes selected.
  251.  
  252.  *Gen.CFG format:
  253.  
  254.     ROOFLOG FALSE
  255.         If TRUE, gives mailer access to the ROOFLOG function host
  256.  
  257.     NOANSWER FALSE                 - his keyword is only applicable to
  258.                                      UMBRELLA.   However, an ENV:  variable
  259.                                      of the same name provides this control
  260.                                      for    the    other    mailers    (See
  261.                                      Shelter.DOC, External Control)
  262.  
  263.     SYSOP    $½SYSOP╗              - your name goes here
  264.     or 
  265.     SYSOP ROBERT WILLIAMSON
  266.  
  267.     CITY "Pierrefonds, Quebec, Canada"
  268.         City, province/state/etc, country. Only required if using EMSI.
  269.  
  270.     PHONE "1-514-696-4768"
  271.         Full phone number or "-unlisted-". Only required if using EMSI.
  272.  
  273.     FLAGS "V32b,V42b,MNP,FAX,CM,XX"
  274.         Your  flags  as listed in nodelist for primary address.  In you are
  275.         not  listed, check EMSI_FLAGS.doc in order to determine which flags
  276.         you should include. Only required if using EMSI.
  277.  
  278.     BOSS 5daddress phonenumber
  279.         The Shelter Manager has an AUTO option which will start the mailer,
  280.         convert .FLO files, call the BOSS address and then exit.  The BOSS
  281.         address  should  be  your Boss if your are a point, or your primary
  282.         mail HUB if you are a node.  The BOSS phone number MUST be entered.
  283.         Use  of this feature is not recommended for sites other than points
  284.         and private nodes.
  285.  
  286.         address                 "site name"      wazooext      zones
  287.     AKA fidonet#1:167/104.0     "Amiga ECS"         org     1 2 3 4 5 6
  288.  
  289.     The first AKA will be used to set your default address and DOMAIN.
  290.  
  291.     address:
  292.         The first address is the default address which will be used when
  293.         calling  or  being  called  by  a  site which is not in any of your
  294.         domains.
  295.  
  296.     sitename:
  297.         This is the name of your system as listed in the nodelist or your
  298.         origin  line  for that domain.  Keep it short as It will be used in
  299.         the wazoo header.
  300.  
  301.     wazooext:
  302.         NOTE:  only FIDONET and MTLNET are authorized to use the 'org' all
  303.         others  must  use  'ftn'.   The criteria is that the FTN's InterNet
  304.         GateWay is KNOWN to the InterNet.
  305.  
  306.     zones:
  307.         the ZONE numbers used by this domain.
  308.  
  309.     Directories:
  310.         DO NOT USE A TRAILING SLASH !
  311.  
  312.     DIR     indir       Mail:inbound
  313.         Where files from secure ftn sites are received.
  314.  
  315.     DIR     nonsecure   Mail:inbound/NONSECURE
  316.         Where files from ftn sites which not passworded or not in your Site
  317.         Cache  are  placed.   You should NEVER automatically import or tick
  318.         these.
  319.  
  320.     DIR     resumedir   Mail:inbound/RESUME
  321.         used internally for secure resume handling.
  322.  
  323.     DIR     outdir      Mail:outbound
  324.         Where outbound archived mail and .?UT file are placed.
  325.  
  326.     DIR     flodir      Mail:outbound/f
  327.         Where  your  obsolete tosser/ticker places obsolete .?LO files.  It
  328.         should NEVER be the same as outdir.  If your obsolete tosser/ticker
  329.         does not allow you to configure this, for security you should use a
  330.         script  to  VIEW  each  flo  file  and  copy ONLY the ones that YOU
  331.         created to flodir.
  332.  
  333.     DIR     rexxdir     Mail:rexx
  334.         Path where Shelter Mailer rexx programs may be found.
  335.  
  336.     DIR     userdir     MAIL:USERS          (ROOF & Porticus only)
  337.         Upload path for humans.
  338.  
  339.     DIR     freqdir     MAIL:inbound/freqs  (ROOF & Porticus only)
  340.         Directory where received freqs are moved by WfreqIt.
  341.  
  342.     DIR     faxindir    Mail:inbound/fax    (ROOF & Porticus only)
  343.         Directory where we receive faxes
  344.  
  345.     DIR     faxoutdir   Mail:outbound/fax   (ROOF & Porticus only)
  346.         Directory where faxes to send are placed
  347.  
  348.     XFERQ           Mail:queue
  349.         Where  Xferq.library  stores  the  queue  files,  XFREQ:   will  be
  350.         assigned  to  this directory.  This should be an directory that YOU
  351.         will NEVER use.
  352.  
  353.     NODELIST       Mail:nodelist
  354.         Where TrapList or Igen stores the nodelists, config files and index
  355.         files. NODELIST: will  be assigned  to  this directory.
  356.  
  357.     PSCREEN "WORKBENCH SCREEN"
  358.         This  is  the screen upon which the Mailers windows will be opened.
  359.         Shelter  will  open  this  screen  (if NOT "WORKBENCH SCREEN") with
  360.         ScreenMgr 1.3c using the values in CFG:SCREEN.CFG.  This program is
  361.         the  ONLY  one  of  the many that I've tested that provides all the
  362.         options  I  wanted in ROOF and does not give me any wierd problems.
  363.         Note that the Mailer windows expect the screen width to be at least
  364.         MAXIMUM OVERSCAN.
  365.  
  366.  
  367.     WSPEC    NOSIZE/NODEPTH/INACTIVE
  368.         Console Specification keywords for Mailer Display
  369.         THESE MUST BE SLASH SEPARATED, one or more of these WB3.1 keywords:
  370.             AUTO CLOSE BACKDROP NOBORDER NODRAG NOSIZE NODEPTH
  371.             NOCLOSE NOZOOM INACTIVE SIMPLE SMART WAIT SCREEN
  372.  
  373.         You should ALWAYS include NOSIZE, as resizing will destroy display.
  374.  
  375. WARNING:
  376.         At  this  time  it is not recommended to use NODRAG or BACKDROP, as
  377. the  code to position multiple linewindows is broken and windows are placed
  378. one on top of another.  :(
  379.  
  380.     WPOS   0/80/600/40      
  381.         Shelter Mailer Status Display position and size,  SLASH SEPARATED
  382.  
  383.     SPOS   0/80/600/100
  384.         Shelter Manager Progress Display position and size, SLASH SEPARATED
  385.  
  386.     SSPEC   INACTIVE/AUTO/WAIT
  387.         Shelter  Progress  Display  Console  Specification  keywords, SLASH
  388.         SEPARATED
  389.  
  390.     LOGFILE "LOG:Mymailer.log"
  391.         Full path name for the mailer log file.
  392.  
  393.     LOGWINDOW "RAW:0/148/650/87/Mailer Log/AUTO/INACTIVE/CLOSE"
  394.         If  this  is  defined,  the  logfile  will also be displayed in the
  395.         window.  DO NOT add SCREEN, this is done automatically.
  396.  
  397.     XPRWIN  TRUE|FALSE
  398.         If true the XPR file transfer window will be displayed.
  399.         If FALSE, you can reenabled it manually via the command:
  400.         RX "ADDRESS <mailername><line> 'Set showxpr TRUE'"
  401.             eg: Rx "Address GAZEBO1 'Set showxpr TRUE'"
  402.  
  403.     DIALWIN TRUE|FALSE
  404.         If  true  poll  progress windows will be displayed.  This should be
  405.         set FALSE if you have a LOGWINDOW defined.
  406.  
  407.     SCROLL <level>
  408.         Select the amonut of information presented in the additional scroll
  409.         window (SPOS, SSPEC).
  410.              5 - launch,preinit,reinit,dial,answer,connect,user
  411.              4 - launch,preinit,dial,answer,connect,user
  412.              3 - dial,answer,connect,user
  413.              2 - connect,user
  414.              1 - user
  415.              0 - scroll window never opens
  416.  
  417. WARNING:
  418.     As  you  should  know, the more windows you have opened, the slower the
  419. response  of  AmigaDOS.   It  is recommmended that you use all windows when
  420. initially  setting  up  your  mailer.   Once  you  are satisfied that it is
  421. operating correctly, I would recommend:
  422.  
  423.     SCROLL      2 (If Porticus, 0 otherwise)
  424.     XPRWIN      FALSE
  425.     DIALWIN     FALSE
  426.     LOGWINDOW   as you prefer
  427.  
  428.     DOMAINAWARE "TRUE"
  429.         Your importer is domain aware and does not require separate inbound
  430.         directories for each domain.  If FALSE, directories will be created
  431.         for each domain and files will be received there.
  432.         If  this  is  FALSE, CMD SORTSESS and CMD SORTRECD will be run for EMSI
  433.         sessions unless PRIMARYONLY is TRUE
  434.  
  435.     PRIMARYONLY TRUE
  436.         Present only our primary (default) address when calling EMSI.
  437.  
  438.     UMH "04:00 06:00"
  439.         This  is  start and end times of your Universal Mail Hour.  This is
  440.         also  known  as  ZMH, but is not necessary limited to one hour.  In
  441.         fact,  to  avoid  problems when switching from Standard to DayLight
  442.         Savings time, many systems set UMH to 2 hours.  YOU are expected to
  443.         use  a  CRON event to set ACCESS FALSE at the beginning and TRUE at
  444.         the end of this period.  This keyword is simply used to inform a
  445.         caller how long to wait before calling back.
  446.  
  447.     WAKEUP 180
  448.         Number of  seconds  between modem wakeup calls. The ATTEN string is
  449.         sent to the modem, if it fails to respond, the INIT string is sent.
  450.         It is not recommended to set this any lower than 45 seconds.
  451.  
  452.     LOGINWAIT   60
  453.         Number  of  seconds  to  wait  for  input after a connection.  This
  454.         applies  to  mailers,  uucp, user command and menus.  60 seconds is
  455.         the recommended minimum.
  456.  
  457.     CALLWINDOWMIN   60
  458.         The  duration  of a call window in minutes.  Poll will be cancel if
  459.         this period is exceeded without a connection.
  460.  
  461.     REDIALDELAY     180
  462.         The delay in seconds to wait between dials on BUSY response. 
  463.  
  464.     BUSYDELAY       60  
  465.         The  delay  in  seconds  to wait between dials when line is already
  466.         dialing another number.
  467.  
  468.     IGNORENOANSWER TRUE
  469.         Treat  a no answer same as busy.  Useful, since most msdos sites do
  470.         not answer when they are tossing mail.
  471.  
  472.  
  473.     CLOCK  TRUE
  474.         Install Atomic CLOCK dialing and connect code if true
  475.  
  476.     ONLINE TRUE
  477.         Install bbs and online service dialing/term launching code if true.
  478.  
  479.     SPEECH TRUE
  480.          Address (or username) called or calling will be spoken if true
  481.  
  482.     WFHOST  TRUE    (ROOF and PORTICUS only)
  483.         Install WPL FunctionHost as Line 1
  484.  
  485.     UUCP    TRUE
  486.         Install  UUCP  code if true, this also sets the mailer to to accept
  487.         UUCP  calls.  The ENV variable may be set FALSE via a cron event in
  488.         order to disable accepting uucp sessions.
  489.  
  490.     ACCESS  TRUE
  491.         Enable  user access, BBS spawning, WPL Utilities.  The ENV variable
  492.         MUST  be  set  FALSE via a CRON EVENT in order to disable executing
  493.         these features.
  494.  
  495.     ALLOWFREQS  TRUE
  496.         Process  inbound  file requests.  The ENV variable may be set FALSE
  497.         via a cron event in order to disable processing file requests.
  498.  
  499.     FTSFREQS    FALSE
  500.         Process  file  requests  in FTS1 sessions.  The ENV variable may be
  501.         set  FALSE  via  a  cron  event in order to disable processing file
  502.         requests during an FTS session.
  503.  
  504.     BANNER  <fullpath>
  505.         If  this keyword is used, the file specifed will be sent instead of
  506.         the  'BAN  welcome'.  GenMailer will check if it exists and exit of
  507.         not. The Mailer will check if it exists before trying to send it.
  508.  
  509.  
  510.     Protocol Preferences
  511.         ZAP - ZedZap, batch, max 8k block, based on baudrate
  512.         ZIP - ZedZip, batch, 1k block
  513.         DZA - DirectZap, escaped control chars
  514.         ZMO - w/1,024 byte data packets
  515.         SEA - SeaLink, xmodem varient
  516.         TLK - Telink, xmodem variant
  517.         DFA - DietIFNA, xmodem/telink/sealink with mailer flags
  518.         LTK - Lotek, xmodem
  519.         KER - Kermit
  520.  
  521.     EMSI_PROTOCOLS "ZAP,DZA,ZMO,SLK,TLK"        (not yet implemented)
  522.         List  of  file transfer protocols, in EMSI format, the first one is
  523.         the  only  one presented when answering.  Only those listed will be
  524.         installed.
  525.  
  526.     WAZOO_PROTOCOLS "ZAP,ZIP,DZA,DFA,LTK"       (not yet implemented)
  527.         List of file transfer protocols, in EMSI format.  Only those listed
  528.         will be installed.
  529.  
  530.   These take numeric values to be applied to a wplvariable
  531.     
  532.     STACK       50000
  533.     PRIORITY    2
  534.         Stack size and priority for external programs
  535.  
  536.     LAUNCHPRI   2
  537.         priority at which a slave is launched
  538.     NEGOPRI     3
  539.         priority to use during WaZoo/EMSI negotiation
  540.     XFERPRI     5
  541.         xferpri is priority of file transfers
  542.  
  543.  
  544.   These take a "string value" to be applied to a wpl variable
  545.  
  546.     LOOKUP "ram:tllookup >NIL:" (NOT APPLICABLE to UMBRELLA)
  547.         The  program used to Lookup Nodelist Info is defined here.  Console
  548.         Output is discarded.
  549.  
  550.     UUCICO  "UUCP:c/uucico -o -pri"
  551.         uucico  command  line.   site  address,  device  and unit are added
  552.         automatically.   Site  specific  options  are added from the uuopts
  553.         entry in the SITE CACHE for each site address
  554.  
  555.     LOGIN   "Mail:login <NULL: >NULL:"
  556.         Login command line, user name, device and unit are added
  557.  
  558.     FAXSEND "Mail:faxsend -f $(unit)/$(device) -l 17 -v"
  559.         Command to send a fax    (ROOF & Porticus only)
  560.  
  561.     FAXRECV
  562.         "Mail:faxrecv -d $(faxindir) -f $(unit)/$(device) -l 17 -v -ii"
  563.         Command to receive a fax (ROOF & Porticus only)
  564.                 
  565.         
  566.     User   Utilities  apply  to  ROOF  &  Porticus  only,  with  the  noted
  567. exceptions.
  568.  
  569.     BULL  <fullpathname>    This file will be sent using XPRascii when a 
  570.                             user logs in. The mailer will check if it 
  571.                             exists before trying to send it.
  572.  
  573.     ESC-ESC  (ROOF and PORTICUS ONLY)
  574.         Determines what will happen when the user hit ESC twice
  575.  
  576.     ESC-ESC BBS             directly launch BBS # 1 without user
  577.                             name prompting
  578.         or
  579.     ESC-ESC SELECT          prompt for user name and show BBS MENU
  580.         or
  581.     ESC-ESC MENU            prompt for user name and show MAIN MENU
  582.  
  583.     MENU GEN|MAKE [RAM]
  584.         Controls how menus are generated and displayed to the caller
  585.  
  586.     MENU GEN
  587.         Menus  will  be  generated as *MENUS.wpl modules.  Menu entries are
  588.         limited to 256 characters.
  589.   
  590.     MENU MAKE 
  591.         Menus  will  be  generated  as  text  files  and be displayed using
  592.         xprascii  protocol.   OutPut  files  will  be  placed  in  CFG:  If
  593.         your  Startup-Sequence  includes  a command to copy *.menu to RAM:,
  594.         use  the  RAM  option  to cause these to be sent instead.
  595.         Generates: MAIN.MENU, MAGIC.MENU, INFO.MENU, BOARD.MENU
  596.     
  597. WARNING:
  598.     Using  xprascii  to  display  the  menus  is  much  slower.  However,te
  599. advantage is that one can use much LARGER and prettier menus.  One can EDIT
  600. these  *.menu  files  to add ANSI and text graphics.  Be sure to back these
  601. up, otherwise they will be overwritten the next time GenMailer is executed.
  602.  
  603.     The main menu will be created with the following entries in addition to
  604. the ones you specify.
  605.  
  606.     MainMenu Default entries:
  607.  
  608.         MAGIC   - the user will be presented with the MAGIC submenu.
  609.  
  610.         INFO    - the user will be presented with the TEXT submenu.
  611.  
  612.         BOARD   - the user will be presented with the BBS submenu.
  613.  
  614.  
  615.     WRM  indicates item is an internal command, while WRX indicates item is
  616. an  external  WPLRX script.  In both cases the command and description will
  617. be  added  to  the  MAIN  menu displayed to the user.  For more info in the
  618. WPLRX commands, see Shelter.DOC.
  619.  
  620.             command     command description
  621.     WRM     HELP        "OnLine help, just enter HELP <command>"
  622.                         The HELP command will search for a file named:
  623.                         INFO:<command>.HLP and display it, if found,
  624.                         using xprascii.library
  625.  
  626.     WRM     UL          "Zmodem Upload to sysop (with resume enabled)"
  627.                         The user wil be prompted for descriptions after
  628.                         the upload.
  629.  
  630.     WRX     GRAB        "Free Zmodem DownLoads"
  631.  
  632.     WRX     NOTE        "Leave a message to Sysop"
  633.  
  634.     WRX     WFREQIT     "File Request Forwarded"
  635.  
  636.     WRX     EMP         "Amiga Empire Game"
  637.  
  638.     WRX     QWK         "Falcon QWK Handler"
  639.  
  640.     WRX     SHOWAC      "View your File Account"
  641.  
  642.     WRX     CHAT        "Page the sysop"
  643.  
  644.     WRM     BYE         "Hangup"
  645.  
  646.  
  647.     TEXT
  648.         These  entries will appear on the INFO submenu.  Files will be sent
  649. via XPRascii.  If description is "na", it will NOT be added to menu.
  650.  
  651.          magicname   fullpath                    desc
  652.     TEXT new      Mail:filelists/newfiles.lst    "View NewFiles This Week"
  653.  
  654.  
  655.  
  656.     MAGIC
  657.         These entries will appear on the MAGIC submenu.  Files will be sent
  658. via  XPRzedzap  using Zmodem.  If description is "na", it will NOT be added
  659. to menu.
  660.  
  661.           magicname   fullpathname                description
  662.     MAGIC files MAIL:FILELISTS/01670104.LHA "Zmodem Send Archived list of Files Available"
  663.  
  664.  
  665.  
  666.     BBS
  667.         List  of  BBSes  for  BBS  Selection menu (ROOF and Porticus only),
  668. Gazebo   permits   only   ONE   BBS   entry.   BBS  is  not  applicable  to
  669. umbrellaGEN.cfg.   Take Note the relationship of the ESC-ESC option to this
  670. menu and the first BBS listed.
  671.  
  672.         The  bbs  name field must be in quotes, the launch command does not
  673. require  enclosing  quotes.   All  imbedded  quotes  MUST be escaped with a
  674. backslash.
  675.  
  676.         A  CLI command line must be used.  If the bbs command detaches from
  677. the  CLI,  you  must run it from a rexx script so that the command does not
  678. return  until the bbs exits.  A simple example for Falcon CBCS, LAUNCH.rexx
  679. is  provided.   You  may  modify  this  for your own bbs.  More complicated
  680. examples,   such   as   Launch_FALCON.rexx   and   Launch_CONTACT.rexx  and
  681. LAUNCH_BBS.rexx may be file requested under those names.
  682.  
  683.         If the bbs is launched via a REXX message then you should do this:
  684.  
  685.     BBS "My BBS" rx \"Address \"MYBBSPORT\" \"mybbscommand $(line) $$(baud)\"\"
  686.  
  687.  
  688.     If  passing  the  modem<->modem  rate,  the  baud  variable  MUST  be
  689. deferred:  $$(BAUD)
  690.  
  691.             bbs name        command to launch it
  692.     BBS     "Amiga ECS"     RPDIR:Launch_BBS $$(baud) $(line)
  693.         or
  694.     BBS     "Amiga ECS"     RX RAM:rexx/Launch_BBS $$(baud) $(line)
  695.  
  696.  
  697.     DOOR
  698.           Any  CLI door or program which can be exited with a BREAK command
  699. may  be  used.  The i/o will be redirected to the modem using the CTDL-AUX:
  700. device.   DOOR.wplrx  start  Carrier.rexx  asyncrounously  to  monitor  the
  701. CARRIER  of  the  line  and then starts the door.  If carrier drops while a
  702. door is active, a BREAK command will be sent to the door.
  703.  
  704.         The  description  field must be in quotes.  The door launch command
  705. does  not  require  enclosing quotes, but any embedded quotes that the door
  706. may require, must be escaped with a backslash.
  707.  
  708.             "description"                       launch command      
  709.     DOOR    "Adventure in The Collossal Cave"   DOORS:adv/adventure
  710.     DOOR    "StarTrek"                          RexxC:rx DOORS:StarTrek \"$$(username)\"
  711.     DOOR    "Grin of the Day"                   RexxC:rx Rexx:rexxdoors/Grin_du_Jour
  712.     DOOR    "Fortune"                           RexxC:rx Rexx:rexxdoors/Your_Fortune
  713.  
  714.  
  715.     CMD
  716.         These  are  the  commands  to execute on file notification for both
  717. AFTERSESSION  and WHENRECD.  Unlike ANY other mailer, multiple commands can
  718. be  executed  based  upon filetype, either when a file is received or after
  719. the  session.  In some cases it may be desireable to have BOTH the WHENRECD
  720. and AFTERSESSION commands executed.
  721.         Note  that the CACHE also permits site-specific PREDIAL, PRESESSION
  722. and AFTERSESSION commands.
  723.  
  724.         Deferred wpl variables are NOT required for these commands.
  725.  
  726.     You  can  specify  these  commands in three ways, in all cases, any WPL
  727. variables must be specified undeferred (ie:  "$(name)").
  728.  
  729.     - as ENV variables so that they are expanded from the the mailer's ENV:
  730.       directory when executed.
  731.     - as expandable ENV vars "$½...╗" so they are expanded from the ROOT of
  732.       ENV:  during compile.
  733.     - as a command string, 
  734.       
  735.     The  command  will  be set as an environmental variable in the mailer's
  736. ENV:  subdirectory.  This allows you to change it on the fly at any time.
  737.  
  738.     See impsess for example of three methods:
  739.  
  740.     CMD entries should NOT be in quotes.
  741.  
  742.     WHENRECD:
  743.     CMD     sortrecd   Run >NIL: Rx ram:rexx/ftnsort $(indir) $(remfile)
  744.                        - sort an archive of packet by ftn domain
  745.                        This command overrides arcrecd and pktrecd 
  746.                        If aftersession processing preferred then set:
  747.                        Echo >>T:sortlist $(indir)$(remfile) 
  748.  
  749.     CMD     arcrecd    Run >NIL: Execute S:TOSSARCS $(host.domain)
  750.                         - import a mail archive
  751.  
  752.     CMD     pktrecd    Run >NIL: Execute S:TOSSPKT $(host.domain) $(remfile)
  753.                         - import a mail packet
  754.  
  755.     CMD     tickrecd   Run >NIL: Ftick CFG:Ftick.cfg.$(host.domain)
  756.                         - process a tic
  757.  
  758.     CMD     uucprecd   - included for completeness, but there is no
  759.                          obvious use for it at this time since uucico
  760.                          calls uuxqt
  761.  
  762.     CMD     faxsent ""  (N/A)   - command to run after sending a fax
  763.     CMD     faxrecd ""  (N/A)   - command to run after receiving a fax
  764.  
  765.     AFTERSESSION:
  766.     CMD     sortsess   Run >NIL: Rx ram:rexx/ftnsort LIST t:sort$<port>list
  767.                        Only set If whenrecd processing not desired.
  768.                        This command overides impsess 
  769.  
  770.     CMD     impsess    Run >NIL: Execute S:TOSSARCS $(host.domain)
  771.                         - start an import for the domain 
  772.                           (as a command string)
  773.  
  774.             impsess     ${IMPSESS}
  775.                         - as an ENV variable, the variable would contain:
  776.                         Run >NIL: Execute S:TOSSARCS $(host.domain)
  777.  
  778.             impsess     $½IMPSESS╗ 
  779.                         - as a expandable ENV variable,
  780.                         the variable would contain:
  781.                         Run >NIL: Execute S:TOSSARCS $(host.domain)
  782.  
  783.  
  784.     CMD     ticksess   Run >NIL: RPDIR:TICKMGR FILE $(host.domain)
  785.                         - process ticks
  786.  
  787.     CMD     freqsess   Run >NIL: Mail:rexx/FreqNote.rexx
  788.                         - process files received for sent requests
  789.  
  790.             NOTE:   If using WFREQIT, you must use:
  791.                        Run >NIL: Mail:rexx/WFREQit-Check $(inbound)
  792.  
  793.     CMD     termsess   Run nil: rx mail:rexx/ftpnote.rexx
  794.                         - command to run after a term program session
  795.  
  796.                         The  included  example  script sets the filenote of
  797.                         files in DL:ftp to the SHORT description in the ftp
  798.                         .readme file.
  799.  
  800.  
  801.         Mail  SORTING and PROCESSING commands are mutually exclusive.  If a
  802. SORTRECD  command  is  set,  the  ARCRECD  and PKTRECD commands will not be
  803. executed.   If  a  SORTSESS  command  is  set,  IMPSESS command will not be
  804. execute.   Keep  in  mind the fact that Site-specific AFTERSESSION commands
  805. OVERRIDE the global ones.
  806.  
  807.         In  my  own  setup,  I  use  both types of command for SORT and TIC
  808. handling.   For  example,  the  TICKRECD  command calls FTICK, which I have
  809. setup  to  make  a  list  of  files received.  The TICKSESS command runs my
  810. TickMGR,  which  uses  this list to post a files received message, redirect
  811. certain  fileechos  to  a  different  area,  check  for  and start nodediff
  812. processing and update my BBS's fileareas lists for each area affected.
  813.  
  814.         I  also do not run any AFTERSESSION command for ARCmail or Packets,
  815. I  only  use  WHENRECD.   This  means  I  import while still online.  It is
  816. amusing when sometimes I can actually reply to a message and send the reply
  817. in  the  same  session  as it was received.  This completely blows away ibm
  818. sysops :) and it is only possible with WPL mailers.
  819.  
  820.         Mail sorting is only enabled in the following situations:
  821.             MULTI is set true for a site in the Cache
  822.             DOMAINAWARE and PRIMARYONLY are FALSE
  823.         In  my own setup my SORTRECD command simply creates a list of files
  824. received.   The SORTSESS command processes this list, extracting and moving
  825. packets to the appropriate inbound area and calling the import script.
  826.  
  827.  
  828.     WPL Variables for WHENRECD, AFTERSESSION and FREQ commands:
  829.  
  830.     The  Host  and Remote addresses are set as stem variables, where <stem>
  831. may be either "host" (us) or "remote" (them).  The stem variable includes:
  832.  
  833.     <stem>.address , <stem>.network, <stem>.text
  834.     <stem>.domain, <stem>.zone, <stem>.net, <stem>.node, <stem>.point
  835.  
  836.     <stem>.network  currently one of 'FIDO', 'UUCP', 'FQDA', 'TEXT'.
  837.  
  838.     <stem>.address  a full nDimensional address list for the <stem>.network
  839.                     as specified by Xferq.
  840.                     For FTN, this would be:  domain#zone:net/node.point
  841.  
  842.         listed          - remote site is listed in the Site Cache
  843.                           or a Nodelist.
  844.         inbound         - current inbound directory (includes trailing slash)
  845.         remfile         - received filename
  846.         infile          - fullpathname of received file
  847.  
  848.     There  are  many  other  variables  available  but  normally  they  not
  849. required.
  850.  
  851.  
  852.  
  853.     FREQ
  854.         FREQ* keywords apply to Gazebo ONLY.  ROOF and PORTICUS use RFS
  855.     and expect RFS.CFG and FREQ.LST to be in RAM:.
  856.  
  857.         XfreqSH  is  an  xferq  command  which allows one to use any .FLO
  858.     style  freq handler with xferq.library and wpl mailers.  Certain Freq
  859.     Handlers are Xferq compatible, such as FreqMate.
  860.  
  861.     Example FREQCFG entries
  862.          ; Internal XfreqSH Freq Handler
  863.          #?.req #RAM:freqlist.lst INFO:BadFreQ.Txt
  864.  
  865.          ; SkyFreq Freq server 2.90 
  866.          #?.req run RAM:skyfreq %R %o %z %N %n %p Sysop %s
  867.  
  868.          ; Freq Handler included with DLG 
  869.          #?.req dlg:tptfreq t:filenotfound %R %O
  870.  
  871.          ; FFRS v1.24
  872.          #?.req RAM:FFRS RAM:FFRS.cfg %R %o %b %z:%N/%n.%p Sysop
  873.  
  874.  
  875.     If using RAM: for fast loading, startup will need to copy them there
  876.  
  877.     FREQCMD RAM:Xfreqsh
  878.     FREQCFG RAM:Xfreqsh.cfg
  879.     FREQLOG LOG:FREQ.LOG
  880.  
  881.  
  882.     BAN
  883.     These are prompts and banners which are displayed to the user.
  884.  
  885.     These are the ROOF ones.
  886.     BAN  timeout "\n\rYou have exceeded the $(loginwait) sec. input timeout, Bye...\r\n"
  887.             Message  sent  to  caller  when  he  has exceeded logindelay.
  888.             System then hangs up.
  889.  
  890.     BAN  sysver "  Roof Mailer v$½SMVER╗ Roof System v$½RVER╗.$½RTAB╗ ${WPLname}"
  891.             System version banner 
  892.  
  893.     BAN  welcome "             /// Welcome To The\r\n            ///    ____  ___  ___  ___\r\n           ///   / _  //   //   // __/\r\n          ///   / __ // / // / // _/\r\n \\\\\\     ///   /_/ \\ /___//___//_/\r\n  \\\\\\   ///\r\n   \\\\\\ /// ? for ROOF menu.\r\n" 
  894.             System Welcome Banner
  895.             The  above to are presented to callers on connect.
  896.             NOTE:  that all '\' backslashes must be escaped.
  897.             If you wish to display a banner larger than 256 bytes, use the
  898.             BANNER keyword.
  899.  
  900.     BAN  sysprompt  "\r\nThe ROOF [Line:$(line)] ? for menu or login: "
  901.             System Command Prompt
  902.  
  903.     BAN  notumh  "Sysop has disabled $(namebuf) access during software upgrade."
  904.             This  is  the message to present to human callers when ACCESS
  905.             is set FALSE outside of UMH.
  906.             NOTE:   the  user will be given the number of minutes to wait
  907.             before calling back if he calls DURING UMH.
  908.  
  909.  
  910.     Here's Umbrella:
  911.  
  912.     BAN  timeout "\n\rYou have exceeded the $(loginwait) sec. input timeout, Bye...\r\n"
  913.     BAN  welcome " Come under my Umbrella, you must be wet.\r\n"
  914.     BAN  sysprompt  "\r\nMailers Only:\r\n"
  915.     BAN  sysver " Umbrella Point Mailer v${WPLVER} ${WPLname}"
  916.  
  917.  
  918.     /* TAGNAME of area where user messages will be posted           */
  919.     SYSOPBASE   ECS_SYSOP
  920.  
  921.     SYSOPBASE <tagname[@domain]>
  922.  
  923.         This  is a TAGNAME as appearing in your tossers config file.  NOTE,
  924.     GRAB  and  UserUL  will  call Smsg to write an inbound packet with this
  925.     TAGNAME.  It is your resposibility to import this packet.
  926.     If the domain is other tha your primary or default domain, you may
  927.     specify the correct domain by using tagname@domainname
  928.  
  929.  
  930. SITE CACHE CONFIGURATION
  931. ------------------------
  932.     CFG:wpl/gen/mailername/Cache.cfg
  933.         This  contains  information  related  to sites with which one has
  934. regular sessions.
  935.     Generated:    roofCACHE.wpl,   gazeboCACHE  or  umbrellaCACHE.wpl  is
  936. generated.
  937.  
  938.     GenMailer  will  create a cache of ftn (nodelist), uucp, internet, bbs,
  939. fax  and  atomic  clock site information for those systems one calls often.
  940. The  removal  of  the  overhead of a Nodelist/L.sys/Passwd Lookup for sites
  941. such  as your net, echomail and usenet feeds, greatly speeds up dialing and
  942. wazoo/emsi/uucico response times.
  943.  
  944.     mailernameCACHE.wpl  is called during a slave startup to set the values
  945. node, number, password, sitename, sysop for EACH slave.  These five MUST be
  946. defined,  in  order for the cache to be useful.  Obviously, one must have a
  947. password  set  with  each  system one caches.  Clock sites do not require a
  948. password.
  949.  
  950.     node aliases:
  951.     
  952.         bbs------   mixed case
  953.                     a BBS or Online service
  954.                     the 'term' command will be executed on connect
  955.  
  956.         fax------   mixed case
  957.                     a fax modem or machine
  958.                     either the faxsend or faxrecv command will be
  959.                     executed on connect.
  960.  
  961.         ---.-.--    last two characters must be mixed case
  962.                     an internet site
  963.                     uucico command will be executed on connect
  964.  
  965.         -------     mixed case
  966.                     a uucp site
  967.                     uucico command will be executed on connect
  968.  
  969.  
  970.     Required Keywords:
  971.     node          ftn address (or addresses), bbs alias, uucp alias 
  972.                   or clock alias. A combination of types is permitted,
  973.                   but uucp may not be in combination with other types.
  974.                      
  975.     number        phone number of site
  976.     password      session or login password (if none, set to "")
  977.     sitename      name of system (in case of uucp/internet, full address)
  978.     sysop         system operator's name
  979.  
  980.     Optional Keywords:
  981.     altnum        alternate number to dial if first one busy
  982.     line          line to use regardless of line requesed by calling script
  983.     dial          alternate dial string to use
  984.     predial       command to run before dialing a site
  985.  
  986.     Additional FTN Site Keywords:
  987.         These need not be entered if FALSE or empty
  988.  
  989.     multi         if TRUE, indicates that site bundles multiple domain
  990.                   packets in a single archive. Requires FTNsort.rexx.
  991.  
  992.     useakasin     if TRUE, we will send all files destined for any of the
  993.                   site's KNOWN FTN AKAs during an INBOUND WAZOO session
  994.                   keyword is not required if FALSE
  995.  
  996.     useakasout    if TRUE, we will send all files destined for any of the
  997.                   site's KNOWN FTN AKAs during an OUTBOUND WAZOO session
  998.                   keyword is not required if FALSE
  999.  
  1000.     sortsess      aftersession command to execute for this site instead
  1001.                   of the global CMD SORTSESS.
  1002.                   This command overides impsess 
  1003.     
  1004.     freqsess      aftersession command to execute for this site instead
  1005.                   of the global CMD FREQSESS, after sending a REQ.
  1006.   
  1007.     ticsess       aftersession command to execute for this site instead
  1008.                   of the global CMD TICSESS, after receiving TICs.
  1009.   
  1010.     impsess       aftersession command to execute for this site instead
  1011.                   of the global CMD IMPSESS, after receiving mail.
  1012.   
  1013.     presess       WPLRX script to run after connect and before handshaking
  1014.                   This  is  intended  to  be  used with call forwarding and
  1015.                   packet switching services
  1016.  
  1017.  
  1018.     Handshake Control Keywords:
  1019.     handshake   comma separated list of handshakes to try with this site
  1020.                 supported: EMSI,WAZOO,FTS1
  1021.                 Handshakes defined for line will be used if keyword not used.
  1022.  
  1023.     present     list of addresses, space separated, to present during 
  1024.                 EMSI handshake.  All AKAs will be presented if this keyword
  1025.                 not used.
  1026.  
  1027.  
  1028.     Additional BBS Site Keywords:
  1029.     term          terminal program launch command
  1030.     termsess      aftersession command to use for this site instead 
  1031.                   of the global CMD TERMSESS
  1032.  
  1033.     Additional Clock Site keywords:    
  1034.     baud          baudrate of this clock site
  1035.     xprsetup      xpr setup string 
  1036.  
  1037.  
  1038.     Additional UUCP Site Keywords:
  1039.     uuoptions    xx -pri -7 -P9
  1040.                   These  are  ADDITIONAL UUCICO command paramters 
  1041.                   to use for this site
  1042.  
  1043.     FTN sites:
  1044.  
  1045.     If  you  have the same password for more than one FTN or address a site
  1046. carries, all these addresses may be placed in the node entry.
  1047.  
  1048.     node        fidonet#1:167/151.0 amiganet#40:600/1.0 amiganet#40:600/151.0
  1049.     number      6847500
  1050.     altnum      4210285
  1051.     line        2
  1052.     sitename    Contact Plus
  1053.     sysop       Denis Turcotte
  1054.     password    xxxxxx
  1055.     useakasin   TRUE
  1056.     handshake   WAZOO,EMSI
  1057.  
  1058.     UUCP/InterNet Sites:    (Not applicable to UMBRELLA)
  1059.  
  1060.     For  UUCP/Internet  sites,  the  node  entry is the alias for the site.
  1061. altnum,  line  and dial keywords are accepted for uucp/internet sites.  The
  1062. sitename keyword is the full address of the site.
  1063.  
  1064.  
  1065.     node        phoenix
  1066.     number      3383798
  1067.     line        3
  1068.     dial        ~AT&K0&M0DT
  1069.     sitename    phoenix.UUCP
  1070.     sysop       Yanik Grignon
  1071.     password    xxxxxx
  1072.  
  1073.  
  1074.     node        odn
  1075.     number      xxxxx
  1076.     dial        ~AT&K1&M4DT
  1077.     line        2
  1078.     sitename    odn.mtlnet.org
  1079.     sysop       Mark Kraml
  1080.     password    xxxxxxx
  1081.  
  1082.  
  1083.     Atomic Clock sites:   (ROOF/PORTICUS Mailers only)
  1084.  
  1085.     Clock  sites  do  not  require  a  password.   Clock  sites use two new
  1086. keywords, baud and xprsetup.
  1087.  
  1088.     node        clock
  1089.     number      16139527729
  1090.     baud        300
  1091.     sitename    National Research Council
  1092.     xprsetup    Y1993,O-4
  1093.  
  1094.     xprsetup  is  the  string  to use with XprClock.library.  "Y" being the
  1095. current  year, "O" your offset from UTC (GMT).  Note that most Atomic Clock
  1096. Sites  will  always give you Standard Time.  If you wish to have you system
  1097. set to DayLight Savings Time, subtract 1 from the offset.
  1098.  
  1099.  
  1100.     OnLine Services and BBS sites:   (Not applicable to UMBRELLA)
  1101.  
  1102.     Shelter  Mailers  can  be used as an auto-dialer frontend for your term
  1103. program.   The  advantage  is that while dialing the bbs or online service,
  1104. your  system  is  still able to perform its ftn/uucp/clock polls as well as
  1105. answer and service incoming calls.
  1106.  
  1107.     BBS  sites  (which  can  include online services such as Compuserve and
  1108. Genie) are entered in the SiteCache as follows:
  1109.  
  1110.     node        bbs_image
  1111.     number      9372137
  1112.     sitename    Electronic Image
  1113.     sysop       Sean Mollitt
  1114.     term        Terminus:TSL IGNOREODU DEFAULTS Terminus$(line).DEF SCRIPT bbs_image.scp  
  1115.  
  1116.     As  with  UUCP  dialing, the 'node' entry is the alias used in the dial
  1117. command.   (eg:   DIAL  bbs_image)  The  'sitename'  and 'sysop' fields are
  1118. displayed in the mailer's GUI, in the same manner as other site types.
  1119.  
  1120.     As  with  all  Cache  dialing,  the  'dial', 'line', 'altnum' and other
  1121. applicable Cache options are supported for BBS dialing.
  1122.  
  1123.     If  the  BBS  is also an FTN node which is already in the cache, simply
  1124. add the term command to the entry and the bbs alias to his AKA list.
  1125.  
  1126.     node        fidonet#1:167/165.0 AMIGANET#40:600/165.0 bbs_image
  1127.  
  1128.     The  'term'  command  MUST  NOT DETACH from the cli.  The configuration
  1129. should  be  line  specific,  otherwise  you  will have to add the $(device)
  1130. $(unit) and possible other variables to the command.
  1131.     The  term program must be told to ignore owndevunit.library since it is
  1132. being  spawned  in  shared  mode.   It  should also be told that there is a
  1133. carrier already present, so that it does not try to initialize the modem or
  1134. change  the  baud  rate.   (Terminus will ASSUME this, if there is either a
  1135. default  STARTUP  script  or a LOGIN script specified on the command line).
  1136. If the term program supports a 'login' script, it should be included in the
  1137. command  line  in  order to automate login.  It is advisable that the login
  1138. script  include  a  timeout routine to EXIT the term program if you are not
  1139. around when connection is made.
  1140.  
  1141.     If  necessary,  one  can use the variables $(line), $(device), $(unit),
  1142. $$(baud),  $(baudlocked),  $(lockedrate),  $(linkrate),  $(maxrate)  in the
  1143. 'term'  command  line.   Remember  that  the  modem<->modem  rate  must  be
  1144. specified as $$(baud).
  1145.  
  1146.     Fax sites:                              (ROOF & PORTICUS ONLY)
  1147.  
  1148.       Sorry.... FEATURE is under development.
  1149.  
  1150.     Site-Specific AFTERSESSION commands:
  1151.     These use the same keywords as the global env CMD type.  If one is site
  1152.     for a site, it will executed instead of the global CMD set in *GEN.cfg.
  1153.  
  1154.     freqsess      aftersession command to execute for this site instead
  1155.                   of the global CMD FREQSESS, after sending a REQ.
  1156.   
  1157.     ticsess       aftersession command to execute for this site instead
  1158.                   of the global CMD TICSESS, after receiving TICs.
  1159.   
  1160.     impsess       aftersession command to execute for this site instead
  1161.                   of the global CMD IMPSESS, after receiving mail.
  1162.  
  1163.     termsess      aftersession command to use for this site instead 
  1164.                   of the global CMD TERMSESS
  1165.  
  1166.        If wpl vriables are used they MUST be deferred.
  1167.  
  1168.  
  1169.  
  1170. MODEM CONFIGURATION
  1171. -------------------
  1172.  
  1173.     Both  the modem itself AND the line are configured here.  Each line can
  1174. be tailored to enable certian operations.
  1175.  
  1176.     CFG:wpl/gen/mailername/modems/MODEMn.CFG
  1177.         Each  modem config contains information related to the particular
  1178. port, device, modem and display.
  1179.     Generated: roof.wpl and roofMODEM.wpl or gazebo.wpl and gazeboMODEM.wpl
  1180.         or Porticus.wpl and porticusMODEM.wpl
  1181.  
  1182.     CFG:wpl/gen/umbrella/modems/MODEM.CFG
  1183.         Umbrella modem config contains information related to the particular
  1184. port, device, modem and display.
  1185.         umbrella.wpl and umbrellaMODEM.wpl are generated.
  1186.  
  1187.     NOTE:   Both  Roof  and Porticus mailers require that modem config file
  1188. names  start  at  2, regardless of wether WPL Function Host is installed or
  1189. not.
  1190.  
  1191.  
  1192.     Modem?.cfg keywords:
  1193.  
  1194.     modem USR Courier 2400e 7Wire
  1195.             The name of the modem to use in window titles.
  1196.  
  1197.     device artser.device 0
  1198.             Serial device and unit number
  1199.  
  1200.     rtscts TRUE
  1201.             enable/disable 7wire hardware handshaking
  1202.             required if LOCKED is TRUE
  1203.  
  1204.     dtrctl 1
  1205.          0  No support for DTR
  1206.          1  Internal   port   'twiddling  the  bits'
  1207.             *USE THIS ON INTERNAL PORT ONLY*
  1208.          2  SET_CTRL_LINES method 
  1209.             (ASDG DSB, PDIO, CMI Multiport, CSA Magnum, etc.)
  1210.  
  1211.     Buffers 8 8
  1212.             Receive and Write Serial Buffers in KBs.
  1213.             Serial Receive buffer: 
  1214.                 This  is a value given to the particular serial driver, and
  1215.                 the driver itself allocates this buffer.
  1216.             Serial Write buffer:
  1217.                 This is the switch to turn on the double buffered writes to
  1218.                 the serial port.  The value has to be greater than the size
  1219.                 of  the  largest  single  write  that  would  be made.  For
  1220.                 example,  a  9600bps+  modem  uses an 8K block to write, so
  1221.                 some  value  LARGER than this (Say 10) should be used.  Two
  1222.                 buffers of this size are allocated.
  1223.  
  1224.                 *NOTE*  :   This  feature separates the good serial drivers
  1225.                 from  the  bad.   If  your  system  does not work with this
  1226.                 turned  on,  a  value of 0 can be used to turn this feature
  1227.                 off.
  1228.  
  1229.     SlowModem FALSE
  1230.             If  TRUE, a 60ms delay will be placed between each character in
  1231.             modem command strings.
  1232.  
  1233.     Locked TRUE         Port is locked at higher rate than modem.
  1234.     lockedbps 19200     the port<->modem rate
  1235.     linkbps 2400        the modem<->modem rate
  1236.     initwait 3          number of seconds to wait for an OK response
  1237.                         after sending Init command.
  1238.  
  1239.     The following control operations on a per line basis.
  1240.  
  1241.     offset 159
  1242.         This  is  the  pixel line for the top of both the XPR and Scrolling
  1243.         mailer displays.
  1244.  
  1245.     lo FALSE
  1246.         If  TRUE,  this line will not accept inbound calls from site not in
  1247.         the site cache or a nodelist.
  1248.  
  1249.     tryfts1 TRUE
  1250.         If TRUE, will enable FTS-0001 (Lotek) sessions on this line.
  1251.  
  1252.     trywazoo TRUE
  1253.         If TRUE, will enable FTS-0006 (WaZoo) sessions on this line.
  1254.  
  1255.     tryemsi FALSE
  1256.         If TRUE, will enable FSC-0056 (EMSI) sessions on this line.
  1257.  
  1258.     FIDONET sites MUST set BOTH tryfts1 and trywazoo TRUE.
  1259.  
  1260.     MODEM RESPONSE STRINGS
  1261.     We define what EVENT will be set by a string or pattern returned by the
  1262. modem.   This  requires  a  pair  of parameters:  the 'event' name, and the
  1263. second parameter is a pattern.  Three types of EVENTS are used:
  1264.  
  1265.     FIND event:
  1266.     The event is the word 'find'.  In this case the second parameter is not
  1267. a  'pattern', but is a string that will be case insensitive compared to the
  1268. response  string.   If  the  string  matches, it will then look at the next
  1269. character looking for a baud rate number.  An example would be:
  1270.  
  1271.     FIND  CONNECT
  1272.  
  1273.     The  event  type  will  be  reported  as 'CONNECT', and the baudrate is
  1274. changed  to the number grabbed after the string, unless the modem is LOCKED.
  1275.  
  1276.     BAUD event:
  1277.     The  event  is  a  number.  In this case the second parameter is a case
  1278. insensitive  AmigaDos  wildcard.   If  it  matches the incoming string, the
  1279. event is set to 'CONNECT', and the baudrate is changed to the given number.
  1280.  
  1281.     TEXT event:
  1282.     The  event  is  text,  in  which  case  the  second parameter is a case
  1283. insensitive  AmigaDos  wildcard.  If the wildcard matches, the event is set
  1284. to the value given by the first parameter.
  1285.  
  1286.     The REQUIRED events are: OK, busy, connect
  1287.  
  1288.     If  not a wildcard, thepattern to Match should exactly match YOUR modem's
  1289. response strings :)
  1290.  
  1291.     examples:
  1292.     event   pattern
  1293.     -----   -------
  1294.     OK      OK              - command ok
  1295.  
  1296.     BUSY    BUSY            - response that will set the busy event
  1297.     BUSY    NO CARRIER
  1298.     BUSY    NO ANSWER
  1299.     BUSY    RING            - this would disable answer
  1300.     BUSY    NO DIALTONE
  1301.  
  1302.     CONNECT CONNECT         - responses that would set the connect event
  1303.  
  1304.     LINE    VOICE           - repsonses that would indicate a line error
  1305.     LINE    CONNECT 0
  1306.     LINE    CONNECT|
  1307.     LINE    ERROR
  1308.  
  1309.     MAID    VOICE           - response that would indicate a human error
  1310.  
  1311.     300     CONNECT         - responses that return CONNECT an the baud rate
  1312.  
  1313.     FIND    CONNECT         - connect baud rate will be returned
  1314.     RING    RING            - response that would set the ring event
  1315.     RING    NO DIALTONE     - this would force answer during dialing
  1316.     RING    NODIALTONE      - this would force answer during dialing
  1317.  
  1318.     FAX     +FCON           - indicates fax connection
  1319.  
  1320.  
  1321.     MODEM COMMAND STRINGS
  1322.  
  1323.     Commands  sent to the modem are interpreted using the following special
  1324. characters:
  1325.  
  1326.             SPECIAL CHARACTERS 
  1327.  
  1328.              ~      add a delay 240ms
  1329.              `      add a delay 60ms
  1330.              |      carriage return
  1331.              ^      raise DTR       Use ONLY if DTRCTL set to 1
  1332.              v      drop dtr        Use ONLY if DTRCTL set to 1
  1333.              \      escape special character 
  1334.                     (in case you USE some of the above as text :)
  1335.  
  1336.     NOTE:  one would precede these characters with the '\' escape character
  1337. if  the special character needed to be sent out the modem).  In order to be
  1338. able  to send an "AT\" type command to the modem, you must use 4 '\' in the
  1339. string.
  1340.     eg:
  1341.         AT\\\\X3
  1342.         AT\v
  1343.  
  1344.     Atten           |~AT|
  1345.     Hangup          v~~^~~ATH0|~AT|
  1346.     Init            ATE1Q0V1X4 &H1&K1&R2&M4&B7 S0=0|
  1347.                     to enable fax connection add appropriate command
  1348.     Dial            ~ATDT
  1349.     Answer          ATA|
  1350.  
  1351.  
  1352.     TECHNICAL INFO:
  1353.     Escape Chars:
  1354.  
  1355.     \       - the following character will be used uninterpreted,
  1356.             this is required for embedded quotes.
  1357.  
  1358.     \n      - Newline (Same as Linefeed)
  1359.     \r      - Return character
  1360.     \###    - send the Octal (base 8) character given by the three
  1361.              digits following the slash.
  1362.  
  1363.     Types of Variables:
  1364.     Variable  types are signified by the $ character, and the variable name
  1365. is  bracketed by a special set of characters, one to begin the bracket, and
  1366. one  to  end.   The  bracketing  character  itself  determines what TYPE of
  1367. variable is used.  To add a '$' character itself to the string, or to defer
  1368. the  expansion  of a wpl variable until execution, use two $ characters one
  1369. after the other.
  1370.  
  1371.     $½╗  - SHELTER *GEN.cfg environmental variable
  1372.            During generation, the variable will be
  1373.            expanded to it's value
  1374.     $()  - WPL variable set with the 'Set' WPL command
  1375.     ${}  - WPL AmigaDOS ENV: global variable,
  1376.            set with the 'SetEnv' WPL command or externally.
  1377.     $[]  - WPL AmigaDOS SHELL local variable,
  1378.            set with the 'SetVar' WPL command or externally.
  1379.     $<>  - WPL read-only calculated variables.
  1380.            These variables are calculated at the time that
  1381.            their value is requested.
  1382.  
  1383.     The following calculated variables are available:
  1384.   $<date> - substitutes an unlocalized date in dd-mm-yy format.
  1385.  
  1386.   $<port> - substitutes the unique REXX compatible message port name that
  1387.             identifies the current slave.
  1388.  
  1389.   $<time> - substitutes the current time in hh:mm:ss format.  This will
  1390.             be localized at a future point.
  1391.  
  1392.     If  a  wpl environment variable is referenced as $½ENVNAME╗, the actual
  1393. value  will be substituted during mailer generation.  ½ and ╗ are the small
  1394. double  bracket  characters:  ALT-9 and ALT-0.  What YOU see depends on the
  1395. font  you  are using; if using an IBM font you will see a small '1/2' and a
  1396. 'double-line top-right corner'.
  1397.  
  1398.     Certain  ENV:   variables,  such  as  "WPLname"  (name  and  version of
  1399. wpl.library)  must  NOT be set to "$½..╗", since they are not set until the
  1400. mailer is loaded.
  1401.  
  1402.     The  "SMVER" variable (version of the Shelter Mailer Manager) is set by
  1403. Shelter, so you must run Shelter before GenMailer in order to use it.
  1404.  
  1405.  
  1406.     The following internal wpl variables may be used where required in BBS,
  1407. TERM, FAX, LOGIN or other command lines:
  1408.  
  1409.         $(line)         - mailer line
  1410.         $(device)       - serial device driver
  1411.         $(unit)         - serial device unit
  1412.         $$(baud)        - modem<->modem bps (deferred expansion)
  1413.         $(baudlocked)   - port<->modem bps
  1414.         $(baud)         - modem<->modem bps (not normally used)
  1415.  
  1416.     DEFERRED EXPANSION:
  1417.     In  some  cases,  it will be necessary to DEFER expansion of a variable
  1418. until  the  command  is  actually  executed.  WPL provides for this, if you
  1419. preceed  the  variable name with a second "$".  For example, if the command
  1420. to  launch  needs  the  actual  baud rate passed to it, and this is true is
  1421. almost  every  case,  you  would  specify $$(baud).  It is not necessary to
  1422. defer  the  expansion the other variables as they are line specific and the
  1423. values do not change.
  1424.  
  1425.     NOTE: deferred expansion should NOT be used in CMD keywords.
  1426.  
  1427.     Please  note  that  if  you  use  the "$½..╗" expansion option, all wpl
  1428. variables  "$()"  that  are  IN  the  environment string such as baud, that
  1429. require deferred expansion should use the $$() option.
  1430.  
  1431.     RECURSIVE EXPANSION:
  1432.     During  operation, variable substitution is recursive, which means that
  1433. the  value  of  a  variable  might  itself contain a variable name, and the
  1434. variable  name  to  be  looked  up  could  itself  be  formed  out of other
  1435. variables.   If  this  recursive calling is not desired, then a single tick
  1436. character  is  used  after  the  $  character  to  indicate that no further
  1437. substitution is requested.  In this non-recursive mode, any $ characters in
  1438. the value of a variable will not cause further variable expansion.  The use
  1439. of  the  single  tick  is very advisable to use when printing out variables
  1440. typed in by a user, so that the user can not attempt to print out passwords
  1441. and other variable values.
  1442.  
  1443.     That's it for now.
  1444.